Get

Function

This API is used to get parameter for System > Network State page.

Request Message

None.

Sample:

POST /API/SystemInfo/Network/Get HTTP/1.1
{
    "version": "1.0",
    "data": {}
}

Response Message

Parameter Description

Table 1

ParameterRangeTypeDescription
wanobjectWan object,see System > Network State > Get > Parameter Description > Table 2 for more information
lanobjectLan object,see System > Network State > Get > Parameter Description > Table 3 for more information
portobjectPort object,see System > Network State > Get > Parameter Description > Table 4 for more information
bandwidthobjectBandwidth object,see System > Network State > Get > Parameter Description > Table 5 for more information
lan1objectLan1 object,see System > Network State > Get > Parameter Description > Table 6 for more information.(used in new network card mode)
lan2objectLan2 object,see System > Network State > Get > Parameter Description > Table 7 for more information.(used in new network card mode)
poeobjectPoe object,see System > Network State > Get > Parameter Description > Table 8 for more information.(used in new network card mode)
pppoeEnable
Disable
stringPPPoE function switch
3gEnable
Disable
string3G network function switch
wifiEnable
Disable
stringWIFI function switch
toeEnable
Disable
stringTOE Acceleration sign

Table 2

Wan object

ParameterRangeTypeDescription
dhcpEnable
Disable
stringDHCP function switch
ip_addressstringIP address, for example: 192.168.1.24
subnet_maskstringSubnet mask, for example: 255.255.255.0
gatewaystringDefault gateway, for example: 192.168.1.1
mac_addressstringPhysical address, such as 88-60-50-4E-87-29
ipv6_addressMax length: 46 bytestringIpv6 address
ipv6_gatewayMax length: 46 bytestringIPv6 gateway

Table 3

Lan object

ParameterRangeTypeDescription
ip_addressstringSwitch IP address
subnet_maskstringSwitch Subnet Mask

Table 4

Port object

ParameterRangeTypeDescription
web
client
rtsp
https
Port,Export,ExportState,Upnpstring
string
string
string
Format: "Internal Port Number, External Port Number, Port UPnP Function Status, Port Enable UPnP Function"
{ExportState:” Active”,” Inactive”}
{Upnp:” Enable”,” Disable”}

Table 5

Bandwidth object

ParameterRangeTypeDescription
Total_BandwidthstringTotal bandwidth
Used_BandwidthstringUsed bandwidth

Table 6

Lan1 Object

ParameterRangeTypeDescription
DhcpEnable
Disable
stringIPv4 DHCP function switch
IP_AddressstringIP address, for example: 192.168.1.24
Subnet_MaskstringSubnet mask, for example: 255.255.255.0
GatewaystringDefault gateway, for example: 192.168.1.1
Dhcpv6Enable
Disable
stringIPv6 DHCP function switch
Ipv6_AddressstringIPv6 address
Ipv6_Prefixlenint
Ipv6_GatewaystringIPv6 gateway
Mac_AddressstringPhysical address, for example: 88-60-50-4E-87-29

Table 7

Lan2 Object

ParameterRangeTypeDescription
DhcpEnable
Disable
stringIPv4 DHCP function switch
IP_AddressstringIP address, for example: 192.168.1.24
Subnet_MaskstringSubnet mask, for example: 255.255.255.0
GatewaystringDefault gateway, for example: 192.168.1.1
Dhcpv6Enable
Disable
stringIPv6 DHCP function switch
Ipv6_AddressstringIPv6 address
Ipv6_Prefixlenint
Ipv6_GatewaystringIPv6 gateway
Mac_AddressstringPhysical address, for example: 88-60-50-4E-87-29

Table 8

Poe object

ParameterRangeTypeDescription
poe_dhcpEnable
Disable
stringPoe DHCP function switch
poe_ip_addressstringPOE IP address, for example: 192.168.1.24
poe_subnet_maskstringPOE subnet mask, for example: 255.255.255.0

Please note that future products will integrate the web and client ports, and the client port will not be opened and this item will be removed from the page in the future. If customers are doing development docking, please do not consider this port again.

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "wan": {
            "dhcp": "Disable",
            "ip_address": "172.16.10.49",
            "subnet_mask": "255.255.252.0",
            "gateway": "172.16.8.1",
            "mac_address": "88-26-1D-AA-8E-E0",
            "ipv6_address": "fe80::8a26:1dff:feaa:8ee0 / 64",
            "ipv6_gateway": "fe80::/64"
        },
        "dns1": "172.18.1.222",
        "dns2": "8.8.8.8",
        "pppoe": "Enable",
        "State": "Connectting",
        "port": {
            "web": "80,80,Inactive,Enable",
            "client": "9000,9000,Inactive,Disable"
        },
        "bandwidth": {
            "total_bandwidth": "114688Kbps",
            "used_bandwidth": "6144Kbps"
        }
    }
}

Error Code

See Response Messages Body and Common error_code for more information.